Docker example updates #4050
Open
Docker example updates #4050
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -7,6 +7,9 @@ The Sample describes several demos of quickly spinning up different Prebid Serve | |||
| In the Sample, we use `docker` and `docker-compose` to instantiate examples; with docker providing a unified setup and interface, you can spin up a demo server instance locally with only one command without knowing all the complexities. | |||
| The docker image used in `docker-compose.yml` is the `Dockerfile` residing in the root level of the repository. | |||
|
|
|||
| > [!NOTE] | |||
| > Depending on what version of Docker is installed on your system, `docker-compose` might be considered deprecated. If you receive an error when trying to run `docker-compose`, use `docker compose` (without the dash) instead. | |||
|
|
|||
There was a problem hiding this comment.
Good point!
Do you think it will give more context if we modify it to this:
Depending on what version of Docker is installed on your system, `docker-compose` might be considered deprecated.
Run `docker-compose` for docker compose version 1.X.
Run `docker compose` (without the dash) for docker compose versions 2.X and 3.X.
For more details please refer to the [History and development of Docker compose](https://docs.docker.com/compose/intro/history/).
I'm open to approve it as is. This is a minor suggestion.
There was a problem hiding this comment.
I like your suggested improvement @VeronikaSolovei9. @jefftmahoney thoughts?
There was a problem hiding this comment.
I also like @VeronikaSolovei9 's suggestion - let's go with that!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Docker Invocation
Adding a note to the README file for the "sample" directory to alert readers that it might, depending upon their system setup, be necessary to invoke
docker composerather thandocker-composewhen running the examples.